Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

testing: lint and docs improvements #24

Merged
merged 1 commit into from
Aug 29, 2023
Merged

Conversation

ccamacho
Copy link
Collaborator

@ccamacho ccamacho commented Aug 29, 2023

This commit resolves the following lint rules:

  • 'yaml'
  • 'yaml[truthy]'
  • 'risky-file-permissions'
  • 'no-changed-when'

It moves 'yaml' to 'yaml[indentation]' and 'yaml[line-length]' to avoid skipping rules that are needed.

Adds an exclusion folder for the .github folder due to ansible/ansible-lint#3645

Updates the toolbox repo 'generate_ansible_default_settings' option to enforce the linting of the parameters and constants.

Partially solves: #10

@openshift-ci
Copy link

openshift-ci bot commented Aug 29, 2023

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kpouget for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 29, 2023
@openshift-ci
Copy link

openshift-ci bot commented Aug 29, 2023

Hi @ccamacho. Thanks for your PR.

I'm waiting for a openshift-psap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

print("", file=f)
print("# Constants", file=f)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why did you chose to add # Parameters & # Constants?
(I don't mind, don't remove it)

I'm not 100% sure myself why I chose to put in Python vs in Ansible, but I think it made more sense to have them side by side in the Python code, somehow like a C header files with prototypes and constants

Copy link
Contributor

@kpouget kpouget left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @ccamacho , looks all good, just ask one clarification to better understand your choice.

I'll merge it soon.

This commit resolves the following lint rules:

- 'yaml'
- 'yaml[truthy]'
- 'risky-file-permissions'
- 'no-changed-when'

It moves 'yaml' to 'yaml[indentation]' and 'yaml[line-length]'
to avoid skipping rules that are needed.

Adds an exclusion folder for the .github folder due to
ansible/ansible-lint#3645

Updates the toolbox repo 'generate_ansible_default_settings'
option to enforce the linting of the parameters and constants.
@kpouget kpouget merged commit 82f3f12 into openshift-psap:main Aug 29, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants